// License text copyright (c) 2020 MariaDB Corporation Ab, All Rights Reserved.
// "Business Source License" is a trademark of MariaDB Corporation Ab.

// Parameters

// Licensor:             Union.fi, Labs Inc.
// Licensed Work:        All files under https://github.com/unionlabs/union's sui subdirectory
//                       The Licensed Work is (c) 2024 Union.fi, Labs Inc.
// Change Date:          Four years from the date the Licensed Work is published.
// Change License:       Apache-2.0
//

// For information about alternative licensing arrangements for the Licensed Work,
// please contact info@union.build.

// Notice

// Business Source License 1.1

// Terms

// The Licensor hereby grants you the right to copy, modify, create derivative
// works, redistribute, and make non-production use of the Licensed Work. The
// Licensor may make an Additional Use Grant, above, permitting limited production use.

// Effective on the Change Date, or the fourth anniversary of the first publicly
// available distribution of a specific version of the Licensed Work under this
// License, whichever comes first, the Licensor hereby grants you rights under
// the terms of the Change License, and the rights granted in the paragraph
// above terminate.

// If your use of the Licensed Work does not comply with the requirements
// currently in effect as described in this License, you must purchase a
// commercial license from the Licensor, its affiliated entities, or authorized
// resellers, or you must refrain from using the Licensed Work.

// All copies of the original and modified Licensed Work, and derivative works
// of the Licensed Work, are subject to this License. This License applies
// separately for each version of the Licensed Work and the Change Date may vary
// for each version of the Licensed Work released by Licensor.

// You must conspicuously display this License on each original or modified copy
// of the Licensed Work. If you receive the Licensed Work in original or
// modified form from a third party, the terms and conditions set forth in this
// License apply to your use of that work.

// Any use of the Licensed Work in violation of this License will automatically
// terminate your rights under this License for the current and all other
// versions of the Licensed Work.

// This License does not grant you any right in any trademark or logo of
// Licensor or its affiliates (provided that you may use a trademark or logo of
// Licensor as expressly required by this License).

// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
// AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
// TITLE.

module ibc::state {
    use sui::bcs;
    use sui::dynamic_field as df;

    const COMMITMENT: u8 = 0x1;
    const COMMITMENT_TO_DIGEST: u8 = 0x2;
    const CHANNEL_TO_PORT: u8 = 0x3;

    public struct PrefixedKey<T: drop> has drop {
        prefix: u8,
        key: T
    }

    /// Commitments storage
    public(package) fun commit(
        id: &mut UID, key: vector<u8>, value: vector<u8>
    ) {
        df::add(id, prefixed_key(COMMITMENT, key), value);
    }

    public(package) fun has_commitment(id: &UID, key: vector<u8>): bool {
        df::exists_(id, prefixed_key(COMMITMENT, key))
    }

    public(package) fun borrow_commitment(id: &UID, key: vector<u8>): &vector<u8> {
        df::borrow(id, prefixed_key(COMMITMENT, key))
    }

    public(package) fun borrow_commitment_mut(
        id: &mut UID, key: vector<u8>
    ): &mut vector<u8> {
        df::borrow_mut(id, prefixed_key(COMMITMENT, key))
    }

    public(package) fun add_or_update_commitment(
        id: &mut UID, key: vector<u8>, value: vector<u8>
    ) {
        if (has_commitment(id, key)) {
            *borrow_commitment_mut(id, key) = value;
        } else {
            commit(id, key, value);
        };
    }

    /// Commitment-to-digest storage
    public(package) fun add_commitment_to_digest(
        id: &mut UID, commitment: vector<u8>, digest: vector<u8>
    ) {
        df::add(
            id,
            prefixed_key(COMMITMENT_TO_DIGEST, commitment),
            digest
        );
    }

    /// Channel-to-port storage
    public(package) fun add_channel_to_port(
        id: &mut UID, channel: u32, port: address
    ) {
        df::add(
            id,
            prefixed_key(CHANNEL_TO_PORT, channel),
            port
        );
    }

    public(package) fun borrow_channel_to_port(id: &UID, channel: u32): address {
        *df::borrow(id, prefixed_key(CHANNEL_TO_PORT, channel))
    }

    public(package) fun has_channel_to_port(id: &UID, channel: u32): bool {
        df::exists_(id, prefixed_key(CHANNEL_TO_PORT, channel))
    }

    fun prefixed_key<K: drop>(prefix: u8, key: K): vector<u8> {
        bcs::to_bytes(&PrefixedKey { prefix, key })
    }
}
